Skip to content

fix: hide new library button for ineligible users in split studio view #35316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
bradenmacdonald merged 4 commits into from
Sep 6, 2024
Merged

fix: hide new library button for ineligible users in split studio view #35316

bradenmacdonald merged 4 commits into from
Sep 6, 2024

Conversation

@kaustavb12
Copy link
Contributor

@kaustavb12 kaustavb12 commented Aug 15, 2024 •
edited
Loading

Description

The user_can_view_create_library_button() function is used to check if the a studio user should be shown the New Library button in Studio.

Currently this works fine in the legacy studio UI, but in the split studio view, users who don't have access to create a library are still shown the New Library button. This creates a confusing user experience since, if such an user tries to create a library, they get an error down the UI flow.

This PR fixes this issue.

As such, this PR does the following:

  1. The New Library button is now only shown to eligible users in the split studio view, instead of all active users.
  2. Common code between user_can_view_create_library_button() and user_can_create_library() functions are refactored out to a new fuction.

Supporting information

This PR is a companion to openedx/frontend-app-authoring#1216

Testing instructions

  1. Setup this PR branch in a local or sandbox environment.
  2. Login to studio through a user account without any staff access
  3. Access the split studio view ( <Studio_URL>/home_library )
  4. Ensure New Library button is missing there.

Other information

Private Ref: BB-9077

@openedx-webhooks
Copy link

openedx-webhooks commented Aug 15, 2024

Thanks for the pull request, @kaustavb12!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 15, 2024
@kaustavb12 kaustavb12 mentioned this pull request Aug 15, 2024
Merged
@kaustavb12 kaustavb12 force-pushed the kaustav/fix_hide_new_library_button_visibility branch from 5221764 to ba1848c Compare August 15, 2024 15:40
0x29a
0x29a approved these changes Aug 19, 2024
View reviewed changes
Copy link
Contributor

@0x29a 0x29a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

  • I've successfully gone through the testing steps.
  • I read through the code.

@kaustavb12 kaustavb12 changed the title fix: hide new library button for ineligible users in course authoring MFE and split studio view fix: hide new library button for ineligible users in split studio view Aug 29, 2024
@kaustavb12 kaustavb12 mentioned this pull request Aug 29, 2024
Merged
@bradenmacdonald bradenmacdonald merged commit 79fb1cc into openedx:master Sep 6, 2024
@bradenmacdonald bradenmacdonald deleted the kaustav/fix_hide_new_library_button_visibility branch September 6, 2024 18:21
@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Sep 6, 2024

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Sep 6, 2024

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Sep 6, 2024

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Sep 6, 2024

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Sep 6, 2024

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Sep 6, 2024

2U Release Notice: This PR has been deployed to the edX production environment.

kaustavb12 added a commit to open-craft/openedx-platform that referenced this pull request Sep 10, 2024
@kaustavb12
fix: hide new library button for ineligible users in split studio view (
54137c0 
openedx#35316)

(cherry picked from commit 79fb1cc)
@kaustavb12 kaustavb12 mentioned this pull request Sep 15, 2024
Merged
@ormsbee ormsbee mentioned this pull request Sep 27, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

+1 more reviewer

@0x29a 0x29a 0x29a approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@kaustavb12 @openedx-webhooks @edx-pipeline-bot @bradenmacdonald @0x29a